Add support for PHPStan 2 #348

sasezaki · 2024-11-15T14:55:32Z

on top of #345, #347

and do " Remove not longer required stubs" @see #309 .

Todos - needs HELP!

Update README example code.
Update .docker (or remove?)
Update gha matrix to test with PHP 8, PHPUnit 10,11

This PR includes a lot of changes to pass CI.

requiments, dependency

Update requirements PHPUnit >=9.1 .
- Becaouse, run test with PHPUnit 8 would cause deprecation warning.
- PHPUnit 9 requires PHP 7.3, and PHPStan requires PHP 7.4. So update requirements is acceptable, I think.
Add requiments phpspec/prophecy-phpunit
Update php-cs-fixer 2 to 3. ( .php_cs to .php-cs-fixer.php)
- to run under recent PHP 8 versions
- I'm not familiar with php-cs-fixer, so if you find any problem, please tell me.

tests

Use PHP's reflection to get stub object, instead of prophesize() call
- PHPStan 2's Reflection\ClassReflection is final class.
- I can't see any good reason to use prophesize() in these unit tests.

src/Type/Prophet/ProphesizeDynamicReturnTypeExtension.php

test/StaticAnalysis/Test/ObjectProphecy/ProphesizeTest.php

src/PhpDoc/ObjectProphecy/TypeNodeResolverExtension.php

stof · 2024-11-18T11:03:57Z

src/Type/ObjectProphecy/WillExtendOrImplementDynamicReturnTypeExtension.php

@@ -92,9 +100,9 @@ public function getTypeFromMethodCall(
            [
                Type\TypeCombinator::intersect(
                    new Type\ObjectType($className),
-                    ...$calledOnType->getTypes()
+                    //...$calledOnType->templ


commenting this looks wrong.

I would also suggest trying to remove that extension entirely (without removing the tests) as I think the phpdoc tags in ObjectProphecy should be enough to describe that already.

Sorry, this is my fault, it's pending in #347 since I didn't know how to do this.

@stof

I think the phpdoc tags in ObjectProphecy should be enough to describe that already.

I agree with your suggestion.

sadly but, current prophecy's phpdoc (from phpspec/prophecy#574) is only about this-out.

* @template U of object * @phpstan-param class-string<U> $interface * @phpstan-this-out static<T&U> */ public function willImplement($interface)

not defined like @phpstan-return static<T&U>.

so we got bellow errors when remove this WillExtendOrImplementDynamicReturnTypeExtension removed.

------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Line test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php ------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 62 Parameter #1 $bar of method JanGregor\Prophecy\Test\StaticAnalysis\Src\BaseModel::bar() expects JanGregor\Prophecy\Test\StaticAnalysis\Src\Bar, JanGregor\Prophecy\Test\StaticAnalysis\Src\Foo given. 🪪 argument.type 84 Method JanGregor\Prophecy\Test\StaticAnalysis\Test\ObjectProphecy\WillImplementTest::createProphecy() should return Prophecy\Prophecy\ObjectProphecy<JanGregor\Prophecy\Test\StaticAnalysis\Src\Bar> but returns Prophecy\Prophecy\ObjectProphecy<JanGregor\Prophecy\Test\StaticAnalysis\Src\Foo>. 🪪 return.type ------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

refs. ( debugging with dumpType)

diff --git a/test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php b/test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php index 05b61de..62693c7 100644 --- a/test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php +++ b/test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php @@ -50,7 +50,12 @@ final class WillImplementTest extends Framework\TestCase public function testCreateProphecyInTestMethod(): void { + $prophecyParamOut = $this->prophesize(Src\Foo::class); + $prophecyParamOut->willImplement(Src\Bar::class); + \PHPStan\dumpType($prophecyParamOut); + $prophecy = $this->prophesize(Src\Foo::class)->willImplement(Src\Bar::class); + \PHPStan\dumpType($prophecy);

------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ Line test/StaticAnalysis/Test/ObjectProphecy/WillImplementTest.php ------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 55 Dumped type: Prophecy\Prophecy\ObjectProphecy<JanGregor\Prophecy\Test\StaticAnalysis\Src\Bar&JanGregor\Prophecy\Test\StaticAnalysis\Src\Foo> 58 Dumped type: Prophecy\Prophecy\ObjectProphecy<JanGregor\Prophecy\Test\StaticAnalysis\Src\Foo> 67 Parameter #1 $bar of method JanGregor\Prophecy\Test\StaticAnalysis\Src\BaseModel::bar() expects JanGregor\Prophecy\Test\StaticAnalysis\Src\Bar, JanGregor\Prophecy\Test\StaticAnalysis\Src\Foo given. 🪪 argument.type 89 Method JanGregor\Prophecy\Test\StaticAnalysis\Test\ObjectProphecy\WillImplementTest::createProphecy() should return Prophecy\Prophecy\ObjectProphecy<JanGregor\Prophecy\Test\StaticAnalysis\Src\Bar> but returns Prophecy\Prophecy\ObjectProphecy<JanGregor\Prophecy\Test\StaticAnalysis\Src\Foo>. 🪪 return.type ------ ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

This is actually a bug in phpstan: phpstan/phpstan#8439

Nope, that can be solved with a conditional type: https://phpstan.org/r/4bd81d3d-c0cf-40bf-a8a8-9b951e317771

* @return ($class is class-string ? ObjectProphecy<T> : ObjectProphecy<object>)

Woha, you already came to the same conclusion a year ago 😄

phpspec/prophecy@9ab4a3c#diff-81b4cc8adbc7615b7b55568528ba2dc2436049e7fd1fd1c1567d8d9ed0d234d5R77

The conditional type does not solve the phpstan bug with willExtend. It only hides it in the case of prophesize. See my new comment on the bug.

@stof

This is actually a bug in phpstan: phpstan/phpstan#8439

oh, my bad! I had did not understand.

at 7061ef1

I rolled back the comment-out.
I assume the reason for the code being commented out was that a method-not-found error would be reported by phpstan if the GenericObjectType was not properly asserted. @Jean85

…/348/files\#r1846388582

…-prophecy/pull/348/files\#r1846392003

Jean85 · 2024-11-19T21:54:11Z

phpspec/prophecy-phpunit 2.3.0 is now released: https://github.com/phpspec/prophecy-phpunit/releases/tag/v2.3.0
Note that this implicitly bumps the Prophecy requirement to 1.18: https://github.com/phpspec/prophecy-phpunit/blob/8819516c1b489ecee4c60db5f5432fac1ea8ac6f/composer.json#L16

The only remaining blocker seems phpstan/phpstan#8439, but we can keep the WillExtendOrImplementDynamicReturnTypeExtension as a workaround for now. WDYT?

…-phpunit requirements to ^2.3 for prophesize() precise types updates https://github.com/Jan0707/phpstan-prophecy/pull/348\#discussion_r1846385958

…ricObjectType will be reported as method not found)

sasezaki · 2024-11-20T14:23:55Z

src/Type/ObjectProphecy/WillExtendOrImplementDynamicReturnTypeExtension.php

@@ -87,14 +95,16 @@ public function getTypeFromMethodCall(
            $className = $scope->getClassReflection()->getName();
        }

+        \assert(\get_class($calledOnType) === Type\Generic\GenericObjectType::class);


This is to avoid assert($calledOnType instanceof Type\Generic\GenericObjectType::class);
( see https://phpstan.org/blog/why-is-instanceof-type-wrong-and-getting-deprecated )
.. I'm not sure this assertion check is good, or not.

checking get_class() === is actually a lot worse than instanceof, as it would even break for child classes. Such check is actually breaking the LSP rule of SOLID if the class being checked is not final (and is strictly equivalent to instanceof for final classes)

Yes, that's absolutely correct. I think I've been relying too much on workarounds.

Looking at PHPStan's own baseline, I noticed that a lot of phpstanApi.instanceofType remains. I think I'll revert it back to instanceof.
https://github.com/phpstan/phpstan-src/blob/2.0.2/phpstan-baseline.neon

sasezaki · 2024-11-20T14:31:09Z

@Jean85

The only remaining blocker seems phpstan/phpstan#8439, but we can keep the WillExtendOrImplementDynamicReturnTypeExtension as a workaround for now. WDYT?

I think keeping the WillExtendOrImplementDynamicReturnTypeExtension is still needed.

…ophecy/pull/348\#discussion_r1850410010

alexander-schranz · 2024-11-21T07:15:03Z

I would keep it aslong as phpstan/phpstan#8439 is not solved. If that is solved we can in future versions remove it and increase the phpstan min version.

Jean85 · 2024-11-21T10:51:08Z

Ok, so we're ok with leaving the WillExtendOrImplementDynamicReturnTypeExtension. Is this PR mergeable then? @sasezaki asked for help on updating the GHA matrix, I can do that but I need to know where; if this isn't merged, I don't know if I should start another PR or not.

alexander-schranz · 2024-11-21T10:59:20Z

@Jean85 fine to continue things in another Pull request.

alexander-schranz and others added 7 commits November 11, 2024 10:14

Allow usage with PHPStan ^2.0

8b6538b

Require new versons

eac5abf

Fix composer style

e60ec15

Fix selectSingle

dc23ccf

Do first-pass refactoring

ebed389

promote types

37d8420

make static-code-analysis-baseline

b0e86b1

sasezaki changed the title ~~[PHPStan 2.0]~~ [WIP][PHPStan 2.0] Nov 15, 2024

sasezaki marked this pull request as ready for review November 15, 2024 14:56

sasezaki requested a review from Jan0707 as a code owner November 15, 2024 14:56

sasezaki marked this pull request as draft November 15, 2024 14:57

sasezaki added 6 commits November 16, 2024 07:45

Remove not longer required stubs

03bd022

Use PHP's reflection to get stub object, instead of prophesize() call

315866a

Update tests basesline

572847d

Update composer.lock

5fb9c1e

composer update

af0682a

require --dev phpspec/prophecy-phpunit

1470fd3

sasezaki force-pushed the phpstan2 branch from fdf9822 to 1470fd3 Compare November 16, 2024 09:26

sasezaki added 3 commits November 16, 2024 19:00

drop support phpunit<9.1 , according to prophecy-phpunit requirements

d78f12b

Update php-cs-fixer config , and apply

cbb6902

Update test's nullable property

8ce5187

sasezaki force-pushed the phpstan2 branch from 5bcc301 to d78f12b Compare November 16, 2024 11:54

sasezaki marked this pull request as ready for review November 16, 2024 12:54

sasezaki changed the title ~~[WIP][PHPStan 2.0]~~ Add support for PHPStan 2 Nov 16, 2024

sasezaki marked this pull request as draft November 16, 2024 13:03

sasezaki marked this pull request as ready for review November 16, 2024 13:24

stof reviewed Nov 18, 2024

View reviewed changes

sasezaki mentioned this pull request Nov 18, 2024

[PHPStan 2.0] replace instanceof usages #347

Closed

sasezaki added 2 commits November 18, 2024 23:20

adding use statement https://github.com/Jan0707/phpstan-prophecy/pull…

3c35259

…/348/files\#r1846388582

Remove TypeNodeResolverExtension - https://github.com/Jan0707/phpstan…

4696fad

…-prophecy/pull/348/files\#r1846392003

Remove ProphesizeDynamicReturnTypeExtension & Update phpspec/prophecy…

a4b90c0

…-phpunit requirements to ^2.3 for prophesize() precise types updates https://github.com/Jan0707/phpstan-prophecy/pull/348\#discussion_r1846385958

sasezaki force-pushed the phpstan2 branch from 164a31e to 4696fad Compare November 20, 2024 13:03

sasezaki added 3 commits November 20, 2024 22:17

Update baselines & composer normalize

cb3a9c7

revert comment out (reason of comment outed is that not asserted Gene…

7061ef1

…ricObjectType will be reported as method not found)

apply php-cs-fixer & Update baseline

c9ab262

sasezaki commented Nov 20, 2024

View reviewed changes

revert it back to instanceof. - https://github.com/Jan0707/phpstan-pr…

87dcaf8

…ophecy/pull/348\#discussion_r1850410010

sasezaki mentioned this pull request Nov 21, 2024

PHPStan 2 compatability #346

Closed

alexander-schranz merged commit cc8c094 into Jan0707:master Nov 21, 2024
5 checks passed

alexander-schranz added the enhancement label Nov 21, 2024

This was referenced Nov 21, 2024

Add support for PHPStan 2 #345

Closed

Remove not longer required stubs #309

Closed

Jean85 mentioned this pull request Nov 21, 2024

Increase CI matrix to test against more recent PHPUnit & PHP versions #351

Merged

sasezaki mentioned this pull request Nov 21, 2024

minimize README code example #353

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for PHPStan 2 #348

Add support for PHPStan 2 #348

sasezaki commented Nov 15, 2024 •

edited

Loading

stof Nov 18, 2024

Jean85 Nov 18, 2024

sasezaki Nov 19, 2024 •

edited

Loading

stof Nov 19, 2024

Jean85 Nov 19, 2024

Jean85 Nov 19, 2024

stof Nov 19, 2024

sasezaki Nov 20, 2024 •

edited

Loading

sasezaki Nov 20, 2024

Jean85 commented Nov 19, 2024

sasezaki Nov 20, 2024

stof Nov 20, 2024

sasezaki Nov 20, 2024

sasezaki commented Nov 20, 2024

alexander-schranz commented Nov 21, 2024

Jean85 commented Nov 21, 2024

alexander-schranz commented Nov 21, 2024

Add support for PHPStan 2 #348

Add support for PHPStan 2 #348

Conversation

sasezaki commented Nov 15, 2024 • edited Loading

requiments, dependency

tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sasezaki Nov 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sasezaki Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jean85 commented Nov 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sasezaki commented Nov 20, 2024

alexander-schranz commented Nov 21, 2024

Jean85 commented Nov 21, 2024

alexander-schranz commented Nov 21, 2024

sasezaki commented Nov 15, 2024 •

edited

Loading

sasezaki Nov 19, 2024 •

edited

Loading

sasezaki Nov 20, 2024 •

edited

Loading